home *** CD-ROM | disk | FTP | other *** search
/ Visual Cafe 3 / Visual Cafe 3.ISO / Vcafe / JFC.bin / MenuElement.java < prev    next >
Text File  |  1998-06-30  |  3KB  |  73 lines
  1. /*
  2.  * @(#)MenuElement.java    1.2 98/01/30
  3.  * 
  4.  * Copyright (c) 1997 Sun Microsystems, Inc. All Rights Reserved.
  5.  * 
  6.  * This software is the confidential and proprietary information of Sun
  7.  * Microsystems, Inc. ("Confidential Information").  You shall not
  8.  * disclose such Confidential Information and shall use it only in
  9.  * accordance with the terms of the license agreement you entered into
  10.  * with Sun.
  11.  * 
  12.  * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
  13.  * SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  14.  * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  15.  * PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR ANY DAMAGES
  16.  * SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
  17.  * THIS SOFTWARE OR ITS DERIVATIVES.
  18.  * 
  19.  */
  20. package com.sun.java.swing;
  21.  
  22. import java.awt.*;
  23. import java.awt.event.*;
  24.  
  25. /**
  26.  * Any component that can be placed into a menu should implement this interface.
  27.  * This interface is used by MenuSelection to handle selection and navigation in
  28.  * menu hierarchies.
  29.  *
  30.  * @version 1.2 01/30/98
  31.  * @author Arnaud Weber
  32.  */
  33.  
  34. public interface MenuElement {
  35.     
  36.     /**
  37.      * Process a mouse event. event is a MouseEvent with source being the receiving element's component.
  38.      * path is the path of the receiving element in the menu
  39.      * hierarchy including the receiving element itself.
  40.      * manager is the MenuSelectionManager for the menu hierarchy.
  41.      * This method should process the MouseEvent and change the menu selection if necessary
  42.      * by using MenuSelectionManager's API
  43.      * Note: you do not have to forward the event to sub-components. This is done automatically
  44.      * by the MenuSelectionManager
  45.      */
  46.     public void processMouseEvent(MouseEvent event,MenuElement path[],MenuSelectionManager manager);
  47.  
  48.  
  49.     /**
  50.      *  Process a key event. 
  51.      */
  52.     public void processKeyEvent(KeyEvent event,MenuElement path[],MenuSelectionManager manager);
  53.  
  54.     /**
  55.      * Call by the MenuSelection when the MenuElement is added or remove from 
  56.      * the menu selection.
  57.      */
  58.     public void menuSelectionChanged(boolean isIncluded);
  59.  
  60.     /**
  61.      * This method should return an array containing the sub-elements for the receiving menu element
  62.      */
  63.     public MenuElement[] getSubElements();
  64.     
  65.     /*
  66.      * This method should return the java.awt.Component used to paint the receiving element.
  67.      * The returned component will be used to convert events and detect if an event is inside
  68.      * a MenuElement's component.
  69.      */
  70.     public Component getComponent();
  71. }
  72.  
  73.